FlowTrigger
The FlowTrigger class is responsible for triggering a flow within a workflow system. It manages the flow's project, parameters, starter user, and execution behavior.
Properties
| Name | Description |
|---|---|
| Key | A unique identifier for the workflow step. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| ParentProcessId | The ID of the parent process for this flow trigger. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| ProjectName | The name of the project to which this flow trigger belongs. |
| ProjectId | The ID of the project to which this flow trigger belongs. |
| TypeCode | The type code associated with the flow object. |
| FlowId | The ID of the flow associated with this trigger. |
| Name | Name for the workflow step. |
| StarterUser | The user who starts the flow. |
| StarterUserType | The type of the starter user (e.g., UserId or UserName). |
| Parameters | A dictionary of flow parameters associated with this flow trigger. |
| Source | The source options for the flow trigger. |
| ShowFlowHistory | Determines whether to show the flow's history. |
| TriggeredProcessCountVariable | The variable to store the count of triggered processes. |
| Caption | The caption dictionary representing localized captions for the flow object. |
| FlowName | The name of the flow associated with this trigger. |
Constructors
| Name | Description |
|---|---|
| FlowTrigger(name, workflowData, workflowCodeInstance) | Constructor for the FlowTrigger class. Initializes a new instance of the FlowTrigger class. |
| FlowTrigger(name, workflowData, workflowCodeInstance) | Constructor for the FlowTrigger class. Initializes a new instance of the FlowTrigger class. |
Methods
| Name | Description |
|---|---|
| Initialize() | Initializes the flow trigger. This method is an implementation of the abstract Initialize method from the base class. |
| SetParentProcessId(parentProcessId) | Sets the parent process ID for this flow trigger. |
| Execute(workflowUserContext, processResponse) | Executes the flow trigger by resolving source data and starting the associated flow. |
| GetParentProcessId() | Returns the parent process ID if available, otherwise returns 0. |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |